auかんたん決済(随時決済) 決済 API一覧

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranAu 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
JobCd		必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount		必須半角数字7桁利用金額
Tax		半角数字7桁税送料
PaymentType		半角数字1桁固定決済タイプ 1：随時決済 ※随時決済を行う場合、必須です。

URL

/payment/EntryTranAu.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranAu 決済実行

KDDIセンターへ決済処理を行い結果を返却します。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
ClientField1		全半角100バイト加盟店自由項目１
ClientField2		全半角100バイト加盟店自由項目２
ClientField3		全半角100バイト加盟店自由項目３
Commodity		必須全角48バイト摘要お客様が購入する商品の情報を設定します。 KDDIセンターでの決済時に表示されます。
ServiceName		必須全角48バイト表示サービス名加盟店様のサービス名称です。お客様の購入履歴などに表示されます。
ServiceTel		必須半角数字記号15桁表示電話番号加盟店様の電話番号です。お客様の購入履歴などに表示されます。設定可能な文字は「半角数字と"-"(ハイフン)」です。
AuAcceptCode		半角英数14桁 au承諾番号随時決済を行う場合、必須です。

URL

/payment/ExecTranAu.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Commodity=テスト摘要&ServiceName=テスト表示サービス名&ServiceTel=03-0000-0000&AuAcceptCode=T2222200000000

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態該当取引の取引状態を返却します。 AUTH：仮売上 CAPTURE：即時売上
TranDate		半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
PayInfoNo		半角数字16桁決済情報番号オーソリ処理が正常終了した時に振り出される番号です。お客様がau ID画面で確認できます。
PayMethod		半角数字2桁固定支払方法支払方法です。 01：合算 02：クレジットカード 06：au PAY カード利用承諾時にお客様が選択した支払方法で決済されます。
CheckString		半角英数32桁改ざんチェック文字列 OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=AUTH&TranDate=20190225162711&PayInfoNo=1234567890123456&PayMethod=01&CheckString=e24243f8308d89d9943279556e852bda

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AuCancelReturn 決済キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト

ShopID	shopID	必須半角英数13桁固定ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）キャンセル金額はオーソリ時の金額を指定してください。 ※0円の場合はエラーとします。 ※精算後（売上確定した翌月以降）のキャンセルのみ一部返品可能です。例）請求525円より全額キャンセル→ キャンセル金額：525 請求525円より210円分キャンセル→キャンセル金額：210
CancelTax	cancelTax	半角数字7桁キャンセル税送料

URL

/payment/AuCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "1000"
}

URL

/payment/AuCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態キャンセル・返品成功時は以下のステータスが返却されます。・CANCEL：キャンセル・RETURN：返品キャンセル・返品失敗時はキャンセル・返品処理前のステータスが返却されます。
Amount	amount	半角数字7桁利用金額利用金額からキャンセル金額を減算した結果を返却します。例）利用金額5000円よりキャンセル金額3000円 => 利用金額2000円
Tax	tax	半角数字7桁税送料税送料からキャンセル税送料を減算した結果を返却します。例）税送料250円よりキャンセル税送料150円 => 税送料100円
CancelAmount	cancelAmount	半角数字7桁キャンセル金額
CancelTax	cancelTax	半角数字7桁キャンセル税送料

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL",
  "amount": "1000",
  "tax": "-",
  "cancelAmount": "1000",
  "cancelTax": ""
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=1000&Tax=0&CancelAmount=1000&CancelTax=0

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AuSales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID	shopID	必須半角英数13桁固定ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料利用金額＋税送料が売上金額となります（1円以上） ※0円の場合はエラーとします。 ※オーソリ時より大きい金額の場合はエラーとします。 ※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL

/payment/AuSales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/AuSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態売上確定成功時は以下のステータスが返却されます。・SALES：実売上売上確定失敗時は売上確定処理前のステータスが返却されます。
Amount	amount	半角数字7桁利用金額売上確定した利用金額を返却します。
Tax	tax	半角数字7桁税送料売上確定した税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "1000",
  "tax": "-"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DeleteAuOpenID OpenID解除

サイトID、会員IDを指定し、該当会員のOpenID解除を行います。お客様のサービス停止や新しいOpenIDの取得が必要になった場合に、OpenID解除を行ってください。

リクエスト

SiteID	siteID	必須半角英数13桁固定サイトID
SitePass	sitePass	必須半角英数64桁サイトパスワード
MemberID	memberID	必須全半角60桁会員ID OpenIDを解除する会員IDを指定します。

URL

/payment/DeleteAuOpenID.json

リクエストパラメータ

{
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "memberID": "membereid"
}

URL

/payment/DeleteAuOpenID.idPass

リクエストパラメータ

SiteID=tsite11223344&SitePass=PASSWORD&MemberID=membereid

レスポンス

正常

SiteID		siteID		半角英数13桁固定サイトID OpenID解除が正常終了の場合は指定されたSiteIDが返却されます。
MemberID		memberID		全半角60桁会員ID OpenID解除が正常終了の場合は指定されたMemberIDが返却されます。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "siteID": "tsite11223344",
  "memberID": "memberid"
}

レスポンスパラメータ：正常系

SiteID=tsite11223344&MemberID=memberid

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001